[]
        
(Showing Draft Content)

Common

Common

[PUT] /api/v2/common/user-info/{id}/homepage

更新指定用户的主页文档 ID。

参数:

名称 类型 位置 描述
id必填项 string path 用户的唯一标识符 (GUID)。示例:“83c07dac-e6b7-4a48-8bf5-fb39fea61620”。

请求数据格式

SetUserHomePageRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/user-info/me

返回值

状态码: 200

成功

UserResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[PUT] /api/v2/common/user-info/preference

更新用户偏好,包括主题、语言、文档类型、时区和欢迎屏幕可见性。

请求数据格式

UpdatePreferenceRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 403

禁止

ServerPluginError

类型定义

Ƭ ServerPluginError

服务器插件错误

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文
innerError ServerPluginError

Ƭ SetUserHomePageRequestModel

表示设置用户主页文档的请求。

名称 类型 描述 示例
userId可为空 string 用户的唯一标识符 (GUID)。 "160C30CC-B9FF-43F8-852A-3BD672176C4B"
userHomeDocumentId可为空 string 要设置为用户主页的文档的唯一标识符 (GUID)。 "8760F2A1-C217-480F-8EB0-1EE9DB3AE2C5"

Ƭ UserResponseModel

用户响应模型

名称 类型 描述 示例
id可为空 string ID
name可为空 string 姓名
email可为空 string 电子邮件
roles可为空 Array<string> 角色
home可为空 string
showWelcomeOnStartup Boolean 启动时显示欢迎信息
isFirstLogin Boolean 首次登录
theme可为空 string 主题
language可为空 string 语言
tenantId可为空 string 租户 ID
tenantName可为空 string 租户名称
securityProvider可为空 string 安全提供商
themeName可为空 string 主题名称
fullName可为空 string 姓名
categoryDocTypes可为空 string 分类文件类型
timeZoneId可为空 string 时区 ID

Ƭ UpdatePreferenceRequestModel

表示更新用户偏好设置的请求模型。

名称 类型 描述 示例
userTheme可为空 string 获取用户的主题偏好。
userLanguage可为空 string 获取用户的语言偏好。
categoryDocTypes可为空 string 获取用户喜欢的文档类型,并进行分类。
timeZoneId可为空 string 获取用户的首选时区ID。
showWelcomeOnStartUp可为空 Boolean 指示是否在启动时显示欢迎屏幕。